Create a new user

This request is used to create a record for a client's new user.

Request syntax

POST https://business.taxi.yandex.ru/api/1.0/client/{client ID}/user/

🔴 We recommend using API 2.0. API 1.0 support will be discontinued in the future.

Request headers:

Authorization

OAuth access token. The steps to get a token are described in Getting started.

Data for the new user is passed in the request body in JSON format:

Field	Description	Format
`email`	The user's email address. Mandatory field. Can be an empty string.	String
`fullname`	The user's full name. Mandatory field. Can be an empty string.	String
`nickname`	The user's short name. Optional field.	String
`phone`	The user's phone number. Mandatory field.	String
`is_active`	Indicates that the user is active. Mandatory field. An inactive user can't place an order and rides can't be ordered in their name.	Logical
`department_id`	Department identification number. Optional field.	String
`role`	A block with information about the user's role. Mandatory field. The role can be specified in the following ways: Using the existing role ID. Using a new user role description. Role description fields are the same as in the Create a new role request (except the name field).	Object
`role_id`	The user role ID number.	String
`classes`	A list of classes available to the user. Pass this field if the `role_id` parameter in the `role` block was omitted.	Array
`limit`	The limits on the amount a user can spend on rides in a calendar month. Optional field.	String
`cost_center`	The default name of the client's cost center. Optional field.	String
`cost_centers`	Information about available cost centers. Optional field. Is obsolete: do not pass this field when using new cost centers. Contains the following fields:`json "required": bool, "format": "string", "values": ["cost_center_1", "cost_center_2"]` `required`: Indicates that the cost center must be specified. `format`: Format for specifying the cost center for the employee. Possible values: `select`: The employee selects the cost center from the list. `text`: The employee specifies the cost center in the text field on their own. `mixed`: The employee can both select the cost center from the list and specify it in the text field. `values`: The list of cost centers available to the employee. List format: `"cost_center1", "cost_center2",...`. Available only if the format value is `mixed` and `select`.	Object

Response field description

Responses may contain the following fields:

Field	Description	Format
`_id`	The user's ID number.	String

Example requests

Request specifying an existing role:

POST https://business.taxi.yandex.ru/api/1.0/client/a2d...d09/user/
...
Authorization: <OAuth token>

    {
        "email": "example-mail@example-company.ru",
        "fullname": "Ilya Ivanov",
        "nickname": "IIlya",
        "department_id": "233e725b0511459da7b38cb24f2d8fd7",
        "role": {
            "role_id": "620d2b39bb154e3ebe5debc8341b3471"
        },
        "phone": "+75551234567",
        "is_active": false,
        "cost_center": "some cost center",
        "cost_centers": {
            "required": true,
            "format": "mixed",
            "values": ["cost center 1", "cost center 2"]
}
    }

Request specifying a new role:

POST https://business.taxi.yandex.ru/api/1.0/client/a2...d09/user/
...
Authorization: <OAuth token>

    {
        "email": "example-mail@example-company.ru",
        "fullname": "Ilya Ivanov",
        "nickname": "IIlya",
        "department_id": "620d2b39bb154e3ebe5debc8341b3471",
        "role": {
            "limit": 10000,
            "classes": ["econom"],
            "restrictions": [
                {
                    "days": ["mo", "we", "sa"],
                    "start_time": "00:00:00",
                    "end_time": "23:59:00",
                    "type": "weekly_date"
                }
            ],
            "geo_restrictions": [
                {
                    "source": "geo_restriction_id1", 
                    "destination": "geo_restriction_id2";
                },
                {
                    "source": "geo_restriction_id3";
                }
            ]
        },
        "phone": "+75551234567",
        "is_active": false,
        "cost_center": "some cost center",
        "cost_centers": {
            "required": true,
            "format": "mixed",
            "values": ["cost center 1", "cost center 2"]
}
    }

Response example

An example response to this request looks like this:

{
        "_id": "3caa3587675b49deb62e3286b753b05e"
}

Response codes

The response to this request may contain the following standard HTTP codes:

200: Request completed successfully.
400: An unknown parameter or a parameter with an invalid value was passed in the request.
401: The OAuth token is incorrect.
403: The client doesn't have sufficient rights to execute this request.
406: A record with the specified parameters already exists.

Was the article helpful?

List of client's users

Detailed user information